﻿/**
 * The AudioTrack Library by Chris J. Rock. Aug 10, 2011
 * Check out chrisjrock.net and be a king among men.
 *
 * Copyright (c) 2011 Chris J. Rock
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 **/


package net.chrisjrock.sound.audioTrack.track
{
	import net.chrisjrock.sound.audioTrack.track.IAudioTrack;
	
	/**
	 * ...
	 * @author Christopher J. Rock
	 */
	public interface IPlayableTrack extends IAudioTrack
	{
		/**
		 * Stops playback and resets the playhead position.
		 * 
		 */		
		function stop():void;
		
		/**
		 * Plays the track from the current playhead position unless 'restart' is true, in which case the track is restarted.
		 * @param restart
		 * 
		 */		
		function play (restart:Boolean = false):void;
		
		/**
		 * Pauses the track at the current playhead position. 
		 * 
		 */		
		function pause():void;
		
		/**
		 * Returns whether or not the current track is being played.
		 * @return 
		 * 
		 */		
		function get playing ():Boolean;
		
		/**
		 * Returns whether or not the current track is paused. 
		 * @return 
		 * 
		 */		
		function get paused ():Boolean;
	}
	
}